home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilThreshImg.z / ilThreshImg
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg - threshold an image
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg : ilMonadicImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilThreshImg performs a threshold operation on an IL image.  Images of any
  19.      data type can be given as input.  Unless explicitly set, the data type of
  20.      ilThreshImg is determined by its (possibly inherited) minimum and maximum
  21.      values.
  22.  
  23.      The threshold is computed on a per channel basis.  That is, each channel
  24.      value of each input pixel is compared to the corresponding channel value
  25.      of the threshold pixel.  If the input value is less than the threshold
  26.      value, then the corresponding output pixel channel value is set to the
  27.      minimum pixel value for that the channel.  Otherwise, it is set to the
  28.      maximum pixel value for that the channel.  If the number of channels in
  29.      the threshold pixel is less than the number of channels in the input
  30.      image, then the value of threshold pixel in the greatest channel is
  31.      applied to the input image channels that do not have a corresponding
  32.      threshold pixel channel.
  33.  
  34. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  35.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  36.  
  37.           ilThreshImg *ilThreshImgCreate(ilImage *img, iflPixel *thresh)
  38.           ilThreshImg *ilThreshImgVal(ilImage *img, float val)
  39.  
  40.      PPPPaaaarrrraaaammmmeeeetttteeeerrrr aaaacccccccceeeessssssss
  41.  
  42.           void ilThreshImgGetThresh(ilThreshImg *img, iflPixel *thresh)
  43.           void ilThreshImgSetThresh(ilThreshImg *img, iflPixel *thresh)
  44.           void ilThreshImgSetThreshVal(ilThreshImg *img, float val)
  45.  
  46.  
  47. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  48.      iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg(((())))
  49.  
  50.           ilThreshImg *ilThreshImgCreate(ilImage *img, iflPixel *thresh)
  51.           ilThreshImg *ilThreshImgVal(ilImage *img, float val)
  52.  
  53.  
  54.           Constructor for the class.  The parameter _i_m_g is the input image;
  55.           _t_h_r_e_s_h is the pixel value used to threshold the input image.  For
  56.           convenience, a float value can be provided as the threshold.  In
  57.           this case, the same threshold value applies equally to each channel.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.      ggggeeeettttTTTThhhhrrrreeeesssshhhh(((())))
  75.  
  76.           void ilThreshImgGetThresh(ilThreshImg *img, iflPixel *thresh)
  77.  
  78.  
  79.           Copies the current threshold pixel value into _t_h_r_e_s_h.
  80.  
  81.      sssseeeettttTTTThhhhrrrreeeesssshhhh(((())))
  82.  
  83.           void ilThreshImgSetThresh(ilThreshImg *img, iflPixel *thresh)
  84.           void ilThreshImgSetThreshVal(ilThreshImg *img, float val)
  85.  
  86.  
  87.           There are two set methods.  The first sets the threshold pixel value
  88.           to _t_h_r_e_s_h.  The second sets the threshold pixel to value _v_a_l in each
  89.           channel.
  90.  
  91. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  92.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMoooonnnnaaaaddddiiiiccccIIIImmmmgggg
  93.      ilMondadicImgGetOffset(), ilMondadicImgSetOffset()
  94.  
  95.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  96.      ilOpImgClearClamp(), ilOpImgGetBias(), ilOpImgGetClamp(),
  97.      ilOpImgGetValidOrders(), ilOpImgGetValidTypes(), ilOpImgIsClamped(),
  98.      ilOpImgIsPrecisionKept(), ilOpImgKeepPrecision(), ilOpImgSetBias(),
  99.      ilOpImgSetClampMinMax(), ilOpImgSetClamp()
  100.  
  101.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  102.      ilMemCacheImgEnableMP(), ilMemCacheImgGetPageTime(),
  103.      ilMemCacheImgGetRetainMode(), ilMemCacheImgGetThrashMode(),
  104.      ilMemCacheImgGetThrashTime(), ilMemCacheImgGetTotalPageTime(),
  105.      ilMemCacheImgIsMPenabled(), ilMemCacheImgSetRetainMode(),
  106.      ilMemCacheImgSetThrashMode()
  107.  
  108.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  109.      ilCacheImgFlush(), ilCacheImgGetCacheSize()
  110.  
  111.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  112.      ilAddInput(), ilAllocFillData(), ilClipTile(), ilClipTileAsTile(),
  113.      ilClipTileFloat(), ilClipTileFloatAsTile(),
  114.      ilConfigureRetainedCacheImage(), ilCopy(), ilCopyTile(), ilCopyTile3D(),
  115.      ilCopyTileCfg(), ilFillTile(), ilFillTile3D(), ilFillTileRGB(),
  116.      ilFreeFillData(), ilGetColorImg(), ilGetColorModel(), ilGetColormap(),
  117.      ilGetColormapPtr(), ilGetCompression(), ilGetConfig(), ilGetCsize(),
  118.      ilGetDataType(), ilGetDimensions(), ilGetDirectInput(),
  119.      ilGetDisplayCacheEnable(), ilGetFill(), ilGetFillData(),
  120.      ilGetFillValue(), ilGetHeight(), ilGetHwEnable(), ilGetHwHint(),
  121.      ilGetHwHintName(), ilGetHwIntHint(), ilGetHwIntHintName(), ilGetInput(),
  122.      ilGetInputTileRequirement(), ilGetLockTileSet(), ilGetMappedPageSize(),
  123.      ilGetMappedSize(), ilGetMaxColormapLevels(), ilGetMaxValue(),
  124.      ilGetMinValue(), ilGetNumChans(), ilGetNumInputs(), ilGetOrder(),
  125.      ilGetOrientation(), ilGetPageBorder(), ilGetPageBorderPtr(),
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllTTTThhhhrrrreeeesssshhhhIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.      ilGetPageBorderX(), ilGetPageBorderY(), ilGetPageBorderZ(),
  141.      ilGetPageCounts(), ilGetPageDelta(), ilGetPageDeltaStruct(),
  142.      ilGetPageDimensions(), ilGetPageIndices(), ilGetPageOrigin(),
  143.      ilGetPageOriginC(), ilGetPageOriginStruct(), ilGetPageOriginX(),
  144.      ilGetPageOriginY(), ilGetPageOriginZ(), ilGetPageSize(),
  145.      ilGetPageSizeBytes(), ilGetPageSizeC(), ilGetPageSizePix(),
  146.      ilGetPageSizeStruct(), ilGetPageSizeVal(), ilGetPageSizeX(),
  147.      ilGetPageSizeXY(), ilGetPageSizeY(), ilGetPageSizeZ(), ilGetPixel(),
  148.      ilGetPixel3D(), ilGetPriority(), ilGetScaleMax(), ilGetScaleMin(),
  149.      ilGetSize(), ilGetSizePtr(), ilGetStrides(), ilGetSubTile(),
  150.      ilGetSubTile3D(), ilGetTile(), ilGetTile3D(), ilGetWidth(), ilGetXsize(),
  151.      ilGetYsize(), ilGetZsize(), ilHasPageBorder(), ilHasPages(),
  152.      ilInitScaleMinMax(), ilIsColorImg(), ilIsIntegral(),
  153.      ilIsMirrorOrientation(), ilIsSigned(), ilIsWritable(), ilLockPage(),
  154.      ilLockPageSet(), ilLockTile(), ilLockTile3D(), ilMapFlipTrans(),
  155.      ilMapFromInput(), ilMapFromInput2D(), ilMapFromInput3D(),
  156.      ilMapFromSource(), ilMapFromSource2D(), ilMapFromSource3D(),
  157.      ilMapOrientation(), ilMapSize(), ilMapTile(), ilMapTileFlipTrans(),
  158.      ilMapTileFloat(), ilMapToInput(), ilMapToInput2D(), ilMapToInput3D(),
  159.      ilMapToSource(), ilMapToSource2D(), ilMapToSource3D(), ilMapXY(),
  160.      ilMapXYFloat(), ilMapXYSign(), ilQCopyTileCfg(), ilQFillTile3D(),
  161.      ilQFillTileRGB(), ilQGetSubTile3D(), ilQGetTile3D(), ilQLockPageSet(),
  162.      ilQSetSubTile3D(), ilQSetTile3D(), ilRemoveHwHint(),
  163.      ilRemoveHwHintName(), ilRemoveInput(), ilSetColorModel(),
  164.      ilSetColormap(), ilSetCompression(), ilSetCsize(), ilSetDataType(),
  165.      ilSetDisplayCacheEnable(), ilSetFill(), ilSetFillValue(),
  166.      ilSetHwEnable(), ilSetHwHint(), ilSetHwIntHint(), ilSetHwIntHintName(),
  167.      ilSetInput(), ilSetMaxColormapLevels(), ilSetMaxValue(), ilSetMinValue(),
  168.      ilSetNumChans(), ilSetOrder(), ilSetOrientation(), ilSetPageBorder(),
  169.      ilSetPageBorderStruct(), ilSetPageSize(), ilSetPageSizeC(),
  170.      ilSetPageSizeStruct(), ilSetPageSizeXY(), ilSetPageSizeZ(), ilSetPixel(),
  171.      ilSetPixel3D(), ilSetPriority(), ilSetScaleMinMax(), ilSetScaleType(),
  172.      ilSetSize(), ilSetSubTile(), ilSetSubTile3D(), ilSetTile(),
  173.      ilSetTile3D(), ilSetXYsize(), ilSetXsize(), ilSetYsize(), ilSetZsize(),
  174.      ilUnlockPage(), ilUnlockPageSet()
  175.  
  176.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  177.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  178.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  179.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  180.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  181.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  182.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  183.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  184.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  185.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  186.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  187.  
  188. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  189.      ilImage, ilCacheImg, ilOpImg, ilMonadicImg
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.